Skip to content

docs: correct connector schema registration to loader-entry pattern - #32775

Open
detail-app[bot] wants to merge 1 commit into
mainfrom
detail/fix-docs/docs-correct-connector-schema-registration-to-load-a73554
Open

docs: correct connector schema registration to loader-entry pattern#32775
detail-app[bot] wants to merge 1 commit into
mainfrom
detail/fix-docs/docs-correct-connector-schema-registration-to-load-a73554

Conversation

@detail-app

@detail-app detail-app Bot commented Sep 6, 2026

Copy link
Copy Markdown

Describe your changes:

Fixes # (no issue — documentation drift correction)

I corrected six living docs that still described the removed "import the
connection schema and add a case '<Service>': switch statement" UI-utils
step for registering a new connector. After the connection-schema move to
public/ and the introduction of the async loadConnectionSchema helper,
the service utils (DatabaseServicePureUtils.ts, DriveServiceUtils.ts,
MetadataServiceUtils.ts, APIServiceUtils.ts, StorageServiceUtils.ts,
...) now expose a <serviceType>SchemaLoaders map and register new
connectors by adding a loader entry that calls
loadConnectionSchema('connections/...') — no static import, no switch case.

Example of the failure the stale docs would cause: an agent or developer
following skills/connector-building/GUIDE.md Step 4 for a new connector
MyDb would try to add case 'MyDb': to DatabaseServiceServiceUtils.tsx,
which no longer exists (the file is DatabaseServicePureUtils.ts and has
no switch). The new connector's form fields would never render, and the
build would fail on the missing import.

Files corrected:

  • skills/standards/main.md — registration checklist item 3
  • skills/connector-building/SKILL.md — Phase 5 summary table, row 4
  • skills/connector-building/GUIDE.md — Step 4 heading + troubleshooting checklist
  • skills/connector-review/templates/full-review-report.md — review checklist row
  • skills/connector-review/templates/specialized-review-report.md — review checklist item
  • ingestion/src/metadata/ingestion/source/database/my_db/CONNECTOR_CONTEXT.md — Step 3b example + filename (DatabaseServiceUtils.tsx -> DatabaseServicePureUtils.ts)

Introduced by commit 171b66d (@chirag-madlani, #32466)

Type of change:

  • Documentation

High-level design:

N/A — small documentation-only change.

Tests:

Not applicable — documentation only.

UI screen recording / screenshots:

Not applicable.

Checklist:

  • I have read the CONTRIBUTING document.
  • My PR title is Fixes <issue-number>: <short explanation>
  • My PR is linked to a GitHub issue via Fixes #<issue-number> above.
  • I have commented on my code, particularly in hard-to-understand areas.
  • For JSON Schema changes: I updated the migration scripts or explained why it is not needed.
  • For UI changes: I attached a screen recording and/or screenshots above.
  • I have added tests (unit / integration / Playwright as applicable) and listed them above.

Doc Drift PRs can be configured here.

@detail-app
detail-app Bot requested a review from a team as a code owner September 6, 2026 23:52
@detail-app
detail-app Bot requested a review from chirag-madlani September 6, 2026 23:52
@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

✅ Playwright Results — workflow succeeded

Validated commit f30cd63659e4d58e8d5e47e7a1b4395881e20ac0 in Playwright run 34069232070, attempt 1.

✅ 619 passed · ❌ 0 failed · 🟡 0 flaky · ⏭️ 0 skipped · 🧰 0 lifecycle flaky

Performance

Blocking targets: ✅ met · Optimization targets: 🟡 in progress

Shard-job maxima below are not the full workflow wall time; the linked run includes build, fixture, planning, and reporting.

🕒 Full workflow signal wall (to summary) 52m 51s

⏱️ Max setup 5m 51s · max shard execution 19m 25s · max shard-job elapsed before upload 22m 31s · reporting 6s

🌐 241.75 requests/attempt · 2.74 app boots/UI scenario · 33.73% common-shard skew

Optimization targets still in progress:

  • Common shard skew was 33.73% (convergence target: at most 15%).
  • Browser traffic was 241.75 requests per attempt (convergence target: fewer than 200).
  • Application boot ratio was 2.74 per UI scenario (1780 boots / 649 scenarios; convergence target: at most 1).
Shard Passed Failed Flaky Skipped Lifecycle failed Lifecycle flaky
✅ Shard chromium-01 135 0 0 0 0 0
✅ Shard chromium-02 135 0 0 0 0 0
✅ Shard chromium-03 129 0 0 0 0 0
✅ Shard data-asset-rules-01 65 0 0 0 0 0
✅ Shard domain-isolation-01 16 0 0 0 0 0
✅ Shard global-state-01 34 0 0 0 0 0
✅ Shard ingestion-01 26 0 0 0 0 0
✅ Shard ingestion-02 37 0 0 0 0 0
✅ Shard reindex-01 2 0 0 0 0 0
✅ Shard search-01 11 0 0 0 0 0
✅ Shard search-rbac-01 29 0 0 0 0 0

📦 Download artifacts

How to debug locally
# Download playwright-test-results-<shard> artifact and unzip
npx playwright show-trace path/to/trace.zip    # view trace

@sonarqubecloud

sonarqubecloud Bot commented Sep 7, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to test Add this label to run secure Github workflows on PRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant